NB IoT 6 Click Example. More...

#include "board.h"
#include "log.h"
#include "nbiot6.h"
#include "conversions.h"

Macros
#define	EXAMPLE_TCP_UDP 0
#define	EXAMPLE_SMS 1
#define	DEMO_EXAMPLE EXAMPLE_TCP_UDP
#define	SIM_APN ""
#define	SIM_SMSC ""
#define	PHONE_NUMBER ""
#define	SMS_MODE "1"
#define	REMOTE_IP "54.187.244.144"
#define	REMOTE_PORT "51111"
#define	MESSAGE_CONTENT "NB IoT 6 Click board - demo example."
#define	APP_BUFFER_SIZE 256
#define	PROCESS_BUFFER_SIZE 256
#define	NETLIGHT_ENABLE "1"
#define	DEREGISTER_FROM_NETWORK "2"
#define	FULL_FUNCTIONALITY "1"
#define	ENABLE_REG "2"
#define	AUTOMATIC_REGISTRATION "0"
#define	ACTIVATE_PDP_CONTEXT "1,1"
#define	PDP_CID "1"
#define	PDP_CID "1"
#define	TCP_SOCKET_NUM "0"
#define	TCP_SERVICE_TYPE "TCP"
#define	UDP_SOCKET_NUM "1"
#define	UDP_SERVICE_TYPE "UDP"

Enumerations
enum	nbiot6_app_state_t { NBIOT6_POWER_UP = 1 , NBIOT6_CONFIG_CONNECTION , NBIOT6_CHECK_CONNECTION , NBIOT6_CONFIG_EXAMPLE , NBIOT6_EXAMPLE }
	Example states. More...

Functions
void	application_init (void)
void	application_task (void)
int	main (void)

Detailed Description

NB IoT 6 Click Example.

Description

Application example shows device capability of connecting to the network and sending SMS or TCP/UDP messages using standard "AT" commands.

The demo application is composed of two sections :

Application Init

Initializes the driver and logger.

Application Task

Application task is split in few stages:

NBIOT6_POWER_UP: Powers up the device and reads system information.
NBIOT6_CONFIG_CONNECTION: Sets configuration to device to be able to connect to the network.
NBIOT6_CHECK_CONNECTION: Waits for the network registration indicated via CEREG command and then checks the signal quality report.
NBIOT6_CONFIG_EXAMPLE: Configures device for the selected example.
NBIOT6_EXAMPLE: Depending on the selected demo example, it sends an SMS message (in PDU or TXT mode) or TCP/UDP message.

By default, the TCP/UDP example is selected.

Additional Function

static void nbiot6_clear_app_buf ( void )
static void nbiot6_log_app_buf ( void )
static err_t nbiot6_process ( nbiot6_t *ctx )
static err_t nbiot6_read_response ( nbiot6_t *ctx, uint8_t *rsp, uint32_t max_rsp_time )
static err_t nbiot6_power_up ( nbiot6_t *ctx )
static err_t nbiot6_config_connection ( nbiot6_t *ctx )
static err_t nbiot6_check_connection ( nbiot6_t *ctx )
static err_t nbiot6_config_example ( nbiot6_t *ctx )
static err_t nbiot6_example ( nbiot6_t *ctx )

Note: In order for the examples to work, user needs to set the APN and SMSC (SMS PDU mode only) of entered SIM card as well as the phone number (SMS mode only) to which he wants to send an SMS. Enter valid values for the following macros: SIM_APN, SIM_SMSC and PHONE_NUMBER. Example: SIM_APN "internet" SIM_SMSC "+381610401" PHONE_NUMBER "+381659999999"

Author: Stefan Filipovic

Macro Definition Documentation

◆ ACTIVATE_PDP_CONTEXT

#define ACTIVATE_PDP_CONTEXT "1,1"

◆ APP_BUFFER_SIZE

#define APP_BUFFER_SIZE 256

◆ AUTOMATIC_REGISTRATION

#define AUTOMATIC_REGISTRATION "0"

◆ DEMO_EXAMPLE

#define DEMO_EXAMPLE EXAMPLE_TCP_UDP

◆ DEREGISTER_FROM_NETWORK

#define DEREGISTER_FROM_NETWORK "2"

◆ ENABLE_REG

#define ENABLE_REG "2"

◆ EXAMPLE_SMS

#define EXAMPLE_SMS 1

◆ EXAMPLE_TCP_UDP

#define EXAMPLE_TCP_UDP 0

◆ FULL_FUNCTIONALITY

#define FULL_FUNCTIONALITY "1"

◆ MESSAGE_CONTENT

#define MESSAGE_CONTENT "NB IoT 6 Click board - demo example."

◆ NETLIGHT_ENABLE

#define NETLIGHT_ENABLE "1"

◆ PDP_CID [1/2]

#define PDP_CID "1"

◆ PDP_CID [2/2]

#define PDP_CID "1"

◆ PHONE_NUMBER

#define PHONE_NUMBER ""

◆ PROCESS_BUFFER_SIZE

#define PROCESS_BUFFER_SIZE 256

◆ REMOTE_IP

#define REMOTE_IP "54.187.244.144"

◆ REMOTE_PORT

#define REMOTE_PORT "51111"

◆ SIM_APN

#define SIM_APN ""

◆ SIM_SMSC

#define SIM_SMSC ""

◆ SMS_MODE

#define SMS_MODE "1"

◆ TCP_SERVICE_TYPE

#define TCP_SERVICE_TYPE "TCP"

◆ TCP_SOCKET_NUM

#define TCP_SOCKET_NUM "0"

◆ UDP_SERVICE_TYPE

#define UDP_SERVICE_TYPE "UDP"

◆ UDP_SOCKET_NUM

#define UDP_SOCKET_NUM "1"

Enumeration Type Documentation

◆ nbiot6_app_state_t

enum nbiot6_app_state_t

Example states.

Predefined enum values for application example state.

Enumerator
NBIOT6_POWER_UP
NBIOT6_CONFIG_CONNECTION
NBIOT6_CHECK_CONNECTION
NBIOT6_CONFIG_EXAMPLE
NBIOT6_EXAMPLE

Function Documentation

◆ application_init()

void application_init ( void )

< Logger config object.

< Click config object.

Logger initialization. Default baud rate: 115200 Default log level: LOG_LEVEL_DEBUG

Note: If USB_UART_RX and USB_UART_TX are defined as HAL_PIN_NC, you will need to define them manually for log to work. See LOG_MAP_USB_UART macro definition for detailed explanation.

◆ application_task()

void application_task ( void )

◆ main()

int main ( void )

Macros

Enumerations

Functions